UPS API
Beginning June 5, 2023, UPS will no longer issue API access keys. Existing access keys will continue to work prior to our conversion to the new UPS API's in early 2024.
DEACOM offers an integrated API to support the creation of UPS Shipping Labels when shipping sales orders in DEACOM. Prior to working with API's within DEACOM, users should read the API Library > eCommerce Developer's Handbook.
The idea with the FedEx and UPS integrations is to register a single ship event and have DEACOM and the carrier communicate everything they need. The goal is to have clients never have to leave DEACOM or double enter an event in another system. That is why Deacom has chosen the Web Services APIs for both FedEx and UPS and integrated them directly into the shipping process.
The UPS API offers the ability to handle international shipping for UPS shipping labels generating and for getting the appropriate rate requests. Specifically, the API adds the Ship-to Attention name and Shipment description to the request for a foreign ship-to. The shipment description is just a concatenation of the package line item descriptions.
Installation process
Before leveraging DEACOM APIs, the DEACOM customer must install the DEACOM Automation Service (DAS) and create the appropriate connection and credentials for accessing data. UPS Credentials are entered on the Sales / Options / APIs tab, in the UPS area. These credentials are provided by UPS when setting up an account for electronic data exchange, and must be entered exactly as provided.
Tech Note: In 2024, FedEx will be discontinuing service of their SOAP API services, and moving forward with their RESTful API implementation.
UPS Package Label contents
The API sends data from the sales order, ship to company, and (if present) the contact person on the sales order to UPS, and UPS returns those fields on the package label image.
- Ship to Company phone number - required for shipping unless contact person phone number is available - prints on the label
- Contact Person phone number - if a contact person is identified on the sales order (Misc2 tab), the record must have a phone number or UPS will complain - prints on the label instead of the ship to company phone number
- Ship to Company contact name - prints at the top of the address block, if not blank
- Contact Person name - if a contact person is identified on the sales order (Misc2 tab), the contact person name will print at the top of the address block instead of the ship to company contact name
- Bill to PO
- Deacom package number (sales order number plus incremental package ID) - prints in the Invoice Number field at the bottom of the label
- Ship to Company name, address, city, state, and zip - prints as the main body of the address block